Skip to content

KNITROAMPL: use \$KNITRODIR/knitroampl/knitroampl for executable - #3979

Merged
blnicho merged 9 commits into
Pyomo:mainfrom
yemine0x01:knitroampl
Aug 26, 2026
Merged

KNITROAMPL: use \$KNITRODIR/knitroampl/knitroampl for executable#3979
blnicho merged 9 commits into
Pyomo:mainfrom
yemine0x01:knitroampl

Conversation

@yemine0x01

@yemine0x01 yemine0x01 commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Fixes # .

NA

Summary/Motivation:

Some KNITRO users install it as a standalone package (not via the Python knitro module) and rely on the KNITRODIR environment variable to locate their installation. Previously, _default_executable() only checked the knitro Python package path first, then fell back to a plain PATH search, meaning users with a KNITRODIR-based installation but no Python package would only succeed if knitroampl happened to be on their PATH.

This PR adds an explicit lookup for $KNITRODIR/knitroampl/knitroampl as the highest-priority candidate, reflecting the standard layout of a standalone KNITRO installation.

Changes proposed in this PR:

AI-Use Disclosure

  • AI tools were NOT used during the preparation of this PR

or

  • AI tools contributed to the development of this PR

    • AI tools generated documentation (including the PR description/comments, code comments, and/or Sphinx documentation)
    • AI tools generated tests (baselines, examples, and/or code)
    • AI tools generated code (apart from tests)

    Review process (select ONE):

    • Rewritten: All AI-generated content was rewritten by me before being committed.
    • Reviewed/verified: I retained AI-generated content and verified it before committing. Verification included (as applicable):
      • Ran the code and fixed issues
      • Added and ran tests
      • Checked correctness/logic of code and tests
      • Checked for alignment with the contribution guide
      • Considered security implications
    • As-is: AI-generated content was commited directly to the repository

Notes for reviewers (optional):

AI was used only for generating the commit message.

Legal Acknowledgement

By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the BSD license.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@yemine0x01
KNITROAMPL: prefer \$KNITRODIR/knitroampl/knitroampl for executable l…
0022a9b 
…ookup

Add \$KNITRODIR/knitroampl/knitroampl as the first candidate in
_default_executable(), before the knitro Python package path and the
system PATH fallback. This allows users with a standalone Knitro
installation (no Python package) to be picked up automatically via the
KNITRODIR environment variable.
@yemine0x01
black format
b739ff9
jsiirola
jsiirola reviewed Jun 25, 2026
View reviewed changes

@jsiirola jsiirola left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks reasonable; however, should the order in which paths are tested be reversed? That is, if the knitro module is available, we should probably use the knitroampl from it (for consistency) before falling back on KNITRODIR?

@yemine0x01

yemine0x01 commented Jun 29, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the review @jsiirola. I checked with the KNITRO dev team on the ordering, and they'd rather keep KNITRODIR first, ahead of the knitro module. Their reasoning is that if a user has set KNITRODIR, that's a deliberate pointer to the install they want used, so it should win. Does that line up with how you're thinking about it?

@codecov

codecov Bot commented Jun 30, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.94%. Comparing base (2744a24) to head (099d8b0).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #3979   +/-   ##
=======================================
  Coverage   89.94%   89.94%           
=======================================
  Files         917      917           
  Lines      109250   109259    +9     
=======================================
+ Hits        98263    98272    +9     
  Misses      10987    10987
Flag Coverage Δ
builders 29.12% <71.42%> (+<0.01%) ⬆️
default 86.14% <100.00%> (?)
expensive 35.10% <85.71%> (?)
linux 87.67% <85.71%> (-1.98%) ⬇️
linux_other 87.67% <85.71%> (+<0.01%) ⬆️
oldsolvers 27.58% <71.42%> (+<0.01%) ⬆️
osx 83.12% <85.71%> (+<0.01%) ⬆️
win 85.43% <85.71%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@blnicho
blnicho merged commit 5384c16 into Pyomo:main Aug 26, 2026
64 of 65 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jsiirola jsiirola jsiirola left review comments
@blnicho blnicho blnicho approved these changes
@mrmundt mrmundt mrmundt approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@yemine0x01 @jsiirola @blnicho @mrmundt @pyomo-autotest